Added license information to documentation landing page #3986
Conversation
There was a problem hiding this comment.
Hello and thanks for your interest in contributing to ✨ Manim ✨
At first glance this seems fine - I'll leave it up to @behackl to check if the wording is okay.
I think it might also be nice to include it on our README as well. If I remember correctly, there's also a special (albeit optional) way to cite Manim - what are your thoughts on including that?
If you have any questions feel free to let us know :)
There was a problem hiding this comment.
Thanks for your contribution! The wording of the paragraph seems fine, there are just a bunch of minor issues I'd like you to look into:
- I think the license information section should be pushed downwards, such that it is the last section before the table of contents.
- The individual text lines are currently very long, please break them such that they do not exceed 100 characters per line.
- The formatting in the rendered documentation is currently broken: reST requires a blank line before the bullet list (see https://docutils.sourceforge.io/docs/user/rst/quickref.html#bullet-lists); you can find a preview of these changes to the documentation at https://manimce--3986.org.readthedocs.build/en/3986/.
Take a look and please let me know in case you have any particular concerns with these changes. Thanks again for your efforts!
|
Thanks, I'll let you know if I need any help, thanks for the documentation, I was lost tbh and had to use chatgpt to understand what I was getting into, your help is much appreciated guys ! |
|
You might also find this link helpful: :) |
Overview: What does this pull request change?
Motivation and Explanation: Why and how do your changes improve the library?
I am new to coding and open source, but I’m passionate about learning and contributing to projects I admire. Manim has been especially inspiring for me; I’ve learned a lot from Grant Sanderson’s videos, and I’m excited to contribute to this library. I wanted to add the license information to help users understand how they can use Manim, as outlined in issue #3833. This is my first pull request for Manim, and I tried to be careful, but any feedback or guidance on improving this PR is much appreciated!
Links to Issue
The License Information was added directly to the main documentation landing page (
index.rstfile). The link to view the issue for this PR is (#3833), where 3833 represents the issue number.Further Information and Comments
I’m very new to programming (less than a year in), and I’m not yet very confident in my skills, but I’m enthusiastic about contributing however I can. I’m grateful for any help or advice the maintainers and reviewers can give me, especially if I’ve made any errors in this PR.
Reviewer Checklist